home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / pc / ELYVER10.ZIP / MIKXMAS.ZIP / docs / mwav.doc < prev    next >
Encoding:
Text File  |  1995-11-20  |  1.7 KB  |  73 lines
  1. ┌───────────────────────────┐
  2. │MWAV.C Module Documentation│
  3. └───────────────────────────┘
  4.  
  5. Date last modified: April 05, 1995
  6.  
  7. If you want to use any of the routines of this module, include "mwav.h" and 
  8. add MWAV.C to your project. This module also uses the MDRIVER.C module so 
  9. make sure you include that too.
  10.  
  11. ════════════════════════════════════════════════════════════════════════════════
  12.  
  13. **** The following routines may only be called if MD_Init() succeeded ****
  14.         See MDRIVER.DOC for more details
  15.  
  16. ════════════════════════════════════════════════════════════════════════════════
  17.  
  18. SAMPLE *MW_LoadWavFP(FILE *fp)
  19. ==============================
  20.  
  21. Input parms:
  22.  
  23.     fp      filepointer to WAV file
  24.  
  25. Returns:
  26.  
  27.     pointer to a SAMPLE structure if it succeeded.
  28.     or
  29.     NULL on error.
  30.  
  31. Description:
  32.  
  33. Load a WAV file by it's filepointer. This routine doesn't close the file when 
  34. it's done, and you cannot assume the fileposition is the same when it returns.
  35.  
  36. ════════════════════════════════════════════════════════════════════════════════
  37.  
  38. SAMPLE *MW_LoadWavFN(char *filename)
  39. ====================================
  40.  
  41. Input parms:
  42.  
  43.     fp      filepointer to WAV file
  44.  
  45. Returns:
  46.  
  47.     pointer to a SAMPLE structure if it succeeded.
  48.     or
  49.     NULL on error.
  50.  
  51. Description:
  52.  
  53. Load a WAV file by it's filename.
  54.  
  55. ════════════════════════════════════════════════════════════════════════════════
  56.  
  57. void MW_FreeWav(SAMPLE *smp)
  58. ============================
  59.  
  60. Input parms:
  61.  
  62.     smp     pointer to a SAMPLE structure
  63.  
  64. Returns:
  65.  
  66.     -
  67.  
  68. Description:
  69.  
  70. Frees a WAV which was previously loaded with MW_LoadWavFN() or MW_LoadWavFP().
  71.  
  72. ════════════════════════════════════════════════════════════════════════════════
  73.